<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
 <head>
  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
  <title>Fetches the document pointed to by a database reference</title>
<link media="all" rel="stylesheet" type="text/css" href="styles/03e73060321a0a848018724a6c83de7f-theme-base.css" />
<link media="all" rel="stylesheet" type="text/css" href="styles/03e73060321a0a848018724a6c83de7f-theme-medium.css" />

 </head>
 <body class="docs"><div class="navbar navbar-fixed-top">
  <div class="navbar-inner clearfix">
    <ul class="nav" style="width: 100%">
      <li style="float: left;"><a href="mongodb.getcollectionnames.html">« MongoDB::getCollectionNames</a></li>
      <li style="float: right;"><a href="mongodb.getgridfs.html">MongoDB::getGridFS »</a></li>
    </ul>
  </div>
</div>
<div id="breadcrumbs" class="clearfix">
  <ul class="breadcrumbs-container">
    <li><a href="index.html">PHP Manual</a></li>
    <li><a href="class.mongodb.html">MongoDB</a></li>
    <li>Fetches the document pointed to by a database reference</li>
  </ul>
</div>
<div id="layout">
  <div id="layout-content"><div id="mongodb.getdbref" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">MongoDB::getDBRef</h1>
  <p class="verinfo">(PECL mongo &gt;=0.9.0)</p><p class="refpurpose"><span class="refname">MongoDB::getDBRef</span> &mdash; <span class="dc-title">Fetches the document pointed to by a database reference</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-mongodb.getdbref-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>MongoDB::getDBRef</strong></span>(<span class="methodparam"><span class="type">array</span> <code class="parameter">$ref</code></span>): <span class="type">array</span></div>

 </div>


 <div class="refsect1 parameters" id="refsect1-mongodb.getdbref-parameters">
  <h3 class="title">Parameters</h3>    
  <p class="para">
   <dl>

    
     <dt>

      <code class="parameter">ref</code>
     </dt>

     <dd>

      <p class="para">
       A database reference.
      </p>
     </dd>

       
   </dl>

  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-mongodb.getdbref-returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="para">
   Returns the document pointed to by the reference.
  </p>
 </div>

 <div class="refsect1 examples" id="refsect1-mongodb.getdbref-examples">
  <h3 class="title">Examples</h3>
  <div class="example" id="example-78">
   <p><strong>Example #1 <span class="function"><strong>MongoDB::getDBRef()</strong></span> example</strong></p>
   <div class="example-contents"><p>
    Example demonstrating how to get a database reference and what the expected
    input is.
   </p></div>
   <div class="example-contents">
 <div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br /><br />&nbsp;$ref&nbsp;</span><span style="color: #007700">=&nbsp;array(<br />&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'$ref'&nbsp;</span><span style="color: #007700">=&gt;&nbsp;</span><span style="color: #DD0000">'profiles'</span><span style="color: #007700">,<br />&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'$id'&nbsp;</span><span style="color: #007700">=&gt;&nbsp;new&nbsp;</span><span style="color: #0000BB">MongoId</span><span style="color: #007700">(</span><span style="color: #DD0000">'47cc67093475061e3d9536d2'</span><span style="color: #007700">)<br />&nbsp;);<br />&nbsp;<br />&nbsp;</span><span style="color: #0000BB">$profile&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">$db</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getDBRef</span><span style="color: #007700">(</span><span style="color: #0000BB">$ref</span><span style="color: #007700">);<br />&nbsp;</span><span style="color: #0000BB">?&gt;</span>
</span>
</code></div>
   </div>

   <div class="example-contents"><p>
    See <span class="function"><a href="mongodb.createdbref.html" class="function">MongoDB::createDBRef()</a></span> for more information about how to programatically create DB references.
   </p></div>
  </div>
 </div>

</div></div></div></body></html>